home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / histbeta.zip / HISTORY.DOC < prev    next >
Text File  |  1988-10-14  |  13KB  |  398 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.         GENHIST/PLAYHIST: v2.01                           by Stephen de Plater
  10.         October 14, 1988                                   GT Net Address 36/1
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.                                   GENHIST / PLAYHIST
  19.                                  by Stephen de Plater
  20.                                  GT Net Address: 36/1
  21.                                  Phone: +61 2 977-3075
  22.  
  23.  
  24.  
  25.  
  26.         ======================================================================
  27.         0.                           REVISION LIST
  28.         ======================================================================
  29.  
  30.         Just to confuse everyone this revision list begins at version 1.10
  31.  
  32.         VERSION:    Release Date:       Comments:
  33.         -------     ------------        --------------------------------------
  34.  
  35.         1.10        May  26, 1988       These  two programs  replace (at least
  36.                                         for users of GT1400) the older program
  37.                                         HISTORY.EXE
  38.  
  39.                                         Added Standard Command Line Interface.
  40.  
  41.         1.11        August 12, 1988     Fixed a couple of minor bugs and added
  42.                                         the new /B parameter.
  43.  
  44.         2.00        October 12, 1988    As  you might guess, a major revision!
  45.                                         In fact, the  code changes were  quite
  46.                                         small, but ... External  protocol file
  47.                                         transfers are now counted  (they never
  48.                                         were before), people who like to wierd
  49.                                         things    in    their    GT.CNF    are
  50.                                         accomodated, and the  different format
  51.                                         of the GT14.03 log is handled.
  52.  
  53.         2.01        October  14,  1988  A  very  small  change  to  accomodate
  54.                                         those who  put their  GT.LOG files  in
  55.                                         directories other than the GTPATH.
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                                      >> page 1 <<
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.         GENHIST/PLAYHIST: v2.01                           by Stephen de Plater
  76.         October 14, 1988                                   GT Net Address 36/1
  77.  
  78.  
  79.  
  80.         ======================================================================
  81.         1.                             COPYRIGHT
  82.         ======================================================================
  83.  
  84.         GENHIST / PLAYHIST  are not placed in the Public Domain. The copyright
  85.         is retained and the software is provided on licence:
  86.  
  87.         You  are free to use and make as  many copies of these programs as you
  88.         wish. You may also give them away to anyone who wants it, provided:
  89.  
  90.         1.     No fee is charged.
  91.         2.     This archive is distributed intact.
  92.         3.     You register the package with me.
  93.  
  94.  
  95.         ======================================================================
  96.         2.                           REGISTRATION
  97.         ======================================================================
  98.  
  99.         Registration is simple. There  is no fee involved at all.  DO NOT send
  100.         any money!  Registration  simply  involves  sending a  me  a  postcard
  101.         advising that you are using  the program. That way I can let  you know
  102.         about updates etc. (It also helps my ego to know that there are people
  103.         who use my stuff!)
  104.  
  105.         Send the card to:     Rev. Stephen de Plater
  106.                               1 Kangaroo St.
  107.                               MANLY, NSW, 2095
  108.                               Australia
  109.  
  110.  
  111.         ======================================================================
  112.         3.                              PURPOSE
  113.         ======================================================================
  114.  
  115.                          (Or what does this thing do anyway?)
  116.  
  117.         GENHIST /  PLAYHIST together  form a  door program  for  GT Power  BBS
  118.         Systems.  In  combination they  present  to  users some  of  the usage
  119.         statistics for the previous day.
  120.  
  121.         Specifically, GENHIST (run once only per day as soon as possible after
  122.         midnight  --  24:01  would be  good  time!)  generates  the two  files
  123.         containng the statistical presentation, and
  124.  
  125.  
  126.  
  127.                                      >> page 2 <<
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.         GENHIST/PLAYHIST: v2.01                           by Stephen de Plater
  142.         October 14, 1988                                   GT Net Address 36/1
  143.  
  144.  
  145.  
  146.         PLAYHIST, a door program, displays the  appropriate one of those files
  147.         to  the  user.  If  you  wish  to  insist that  your  users  see  this
  148.         information (as some  systems in  Sydney do) then  you should  include
  149.         PLAYHIST in  your  logon  door. If  you  are not  running  GT1400  and
  150.         therefore  do not  have logon  doors  available, then  with  a bit  of
  151.         judicious DOS copying you could add the output to your logon bulletin.
  152.  
  153.         The output includes:
  154.  
  155.         1.     The number of users known to the system,
  156.  
  157.         2.     The number of users currently banned,
  158.  
  159.         3.     The number of known users who were online yesterday,
  160.  
  161.         4.     The  number of connects  registered yesterday. It  may be quite
  162.                different from 3 above, if for instance, some users logged on a
  163.                number of times.
  164.  
  165.         5.     The total, minimum, maximum,  and average time used  in minutes
  166.                and seconds,
  167.  
  168.         6.     The  total,  minimum,  maximum,  and  average number  of  bytes
  169.                downloaded from your system,
  170.  
  171.         7.     The  total,  minimum,  maximum,  and  average number  of  bytes
  172.                uploaded to your system.
  173.  
  174.         The output will  be presented in  a standard form  which is always  14
  175.         lines long, including blank top and bottom lines.
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.                                      >> page 3 <<
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.         GENHIST/PLAYHIST: v2.01                           by Stephen de Plater
  208.         October 14, 1988                                   GT Net Address 36/1
  209.  
  210.  
  211.  
  212.         ======================================================================
  213.         4.                               USAGE
  214.         ======================================================================
  215.  
  216.         To use the GENHIST / PLAYHIST combination:
  217.  
  218.         1.     Place both programs in your DOS path.
  219.  
  220.         2.     Create a  scheduled event  which will  run GENHIST  immediately
  221.                after midnight.
  222.  
  223.         3.     Add PLAYHIST to your logon door.
  224.  
  225.  
  226.         ======================================================================
  227.         5.                      COMMAND LINE PARAMETERS
  228.         ======================================================================
  229.  
  230.         GENHIST supports three command line parameters as follows:
  231.  
  232.         1.     /Dnn Delay time in seconds. If this is the only program in your
  233.                     midnight event,  then it  will run very  quickly, and  you
  234.                     will be returned to the bbs  before the minimum window for
  235.                     the event  (one minute)  has elapsed.  If that  occurs you
  236.                     will immediately  go  out and  run  the event  again,  and
  237.                     again,  and  again ...  until the  minute  is used  up. To
  238.                     prevent this  happening, this parameter  forces GENHIST to
  239.                     take at least nn seconds to complete.
  240.  
  241.                     The default time is 60 seconds.
  242.  
  243.         2.     /N   By default, GENHIST  will create  (and PLAYHIST will  look
  244.                     for) files called HISTORY.BBS and HISTORY.CBS. If you want
  245.                     a different name,  this is where you put it.  You may only
  246.                     supply the simple filename here,  NOT the extension, which
  247.                     will be added by GENHIST. You  should not specify a path--
  248.                     GENHIST and PLAYHIST  will always look only  in the GTPATH
  249.                     directory for these files.
  250.  
  251.                     For example, if you want to  use the name "MYHIST" instead
  252.                     of  "HISTORY"  and  have  GENHIST  create  MYHIST.BBS  and
  253.                     MYHIST.CBS, then use the following parameter:
  254.  
  255.                     /Nmyhist
  256.  
  257.  
  258.  
  259.                                      >> page 4 <<
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.         GENHIST/PLAYHIST: v2.01                           by Stephen de Plater
  274.         October 14, 1988                                   GT Net Address 36/1
  275.  
  276.  
  277.  
  278.                     Note that there are NO spaces allowed!
  279.  
  280.         3.     /B   If the  /B  parameter  is  supplied it  must  be  followed
  281.                     immediately by one single (case sensitive) character. This
  282.                     character represents one access level  which is treated as
  283.                     a  ban  level.  Some sysops  do  not  wish  to simply  ban
  284.                     unwanted users,  because that  prevents the  log recording
  285.                     any attempts by them to get on, but instead set up a level
  286.                     with a very short  time and no effective access  which has
  287.                     the same effect. On this system, for instance, it is level
  288.                     "z". Be careful of the case (it does count), and note that
  289.                     for this to register this way it must be an exact match.
  290.  
  291.                     i.e: /Bx would  only ban users  at level "x",  but not  at
  292.                     levels "y" or "z". On this system I use /Bz.
  293.  
  294.         The  command line  parameters may  not be  run together,  and may  not
  295.         contain internal spaces. i.e.: "/d 99", "/d99/nMYHIST" are both wrong;
  296.         "/d99 /nMYHIST" is fine! Case does not matter.
  297.  
  298.  
  299.         PLAYHIST supports two command line parameters as follows:
  300.  
  301.         1.     /M   Force ANSI  graphics OFF, no  matter whether the  user has
  302.                     them selected or not. The default is to let users who have
  303.                     selected ANSI  graphics see the color file,  and users who
  304.                     have not see the monochrome file.
  305.  
  306.         2.     /N   Use  a  different  filename  other  than  HISTORY.BBS  and
  307.                     HISTORY.CBS. Matches the same parameter in GENHIST.
  308.  
  309.  
  310.         ======================================================================
  311.         6.                              COLORS
  312.         ======================================================================
  313.  
  314.         PLAYHIST  is sensitive to the  presence of GT1400.  If it is detected,
  315.         and if the user has ANSI graphics selected, CHANGE will use the colors
  316.         which the GT1400 is using. Otherwise, it will run in monochrome. There
  317.         is nothing  which you  have to  do to tell  it which  version you  are
  318.         running -- let it figure it out for itself!
  319.  
  320.         GENHIST makes  no assumptions.  It creates  files for  both color  and
  321.         monochrome.
  322.  
  323.  
  324.  
  325.                                      >> page 5 <<
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.         GENHIST/PLAYHIST: v2.01                           by Stephen de Plater
  340.         October 14, 1988                                   GT Net Address 36/1
  341.  
  342.  
  343.  
  344.         ======================================================================
  345.         7.                            DISCLAIMER
  346.         ======================================================================
  347.  
  348.         Q:         What kind of guarantee comes with this software?
  349.  
  350.         A:                    *** ABSOLUTELY NONE!!! ***
  351.  
  352.         I take no responsibility at  all for what this software may do  on any
  353.         computer other than my  own. If you use it you do so at your own risk.
  354.         All that I am prepared to say about it is that it works fine here (and
  355.         I  can see no good reason why  it should not also work fine everywhere
  356.         else also -- but ....)
  357.  
  358.         By using this program you accept these conditions.
  359.  
  360.  
  361.         ======================================================================
  362.         8.                              ENJOY!
  363.         ======================================================================
  364.  
  365.         At least, I hope you do!
  366.         Stephen
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.                                      >> page 6 <<
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.